ScenarioLock Json Schema

ScenarioLock

creationDate : string

id : ObjectId

counter : integer

internal only

date : string

The current date.

internal only

machineIdentifier : integer

internal only

processIdentifier : integer

internal only

time : integer

internal only

timeSecond : integer

internal only

timestamp : integer

internal only

modifiedByOverride : string

origin : string

The source of where the pricing result came from. These sources are fixed set enums

pricedOnMarketPlace : boolean

A boolean flag used to indidcate if the pricing result came from the market place view.

pricingUserFullName : string

pricingUserId : ObjectId

search : Search

The search used to generate the priced product that will be used to update the lock.

accessCriteria : AccessCriteria

accessPortal : string

internal only

companyIds : Array[ObjectId]

Pass an array of company IDs to search on those lenders only. Required field.

internal only

counter : integer

internal only

date : string

The current date.

internal only

machineIdentifier : integer

internal only

processIdentifier : integer

internal only

time : integer

internal only

timeSecond : integer

internal only

timestamp : integer

internal only

dataLog : boolean

Select True to log search data. Default value is False.

internal only

fieldsToRemove : Array[string]

An array of fields to remove from the search results.

internal only

id : ObjectId

Metadata for the AccessCriteria object is stored within the id field.

internal only

marketPlaceSearch : boolean

Set this value to True if you want to simulate a "marketplace" for the broker search.

Default value is False.

overrideNode : integer

internal only

userContext : UserContext

groupType : string

groups : Array[GroupOverride]

externalId : string

nmlsId : string

id : ObjectId

overrided : boolean

userEmail : string

userId : ObjectId

username : string

adjustmentDate : string

allDayLocks : boolean

brokerCriteria : BrokerCriteria

adjCodeToExclude : Array[string]

adjNameToExclude : Array[string]

adjustments : Array[Adj]

An array of adjustments to apply to the loan cost. Adjustments are flat fees that are similar to closing costs, but simpler in terms of calculation.

Adjustment data is stored in the Adj object.

For more information, see Adjustments and Closing Costs.

adj : number

The adjustment number.

adjGroupCode : string

adjType : string

The adjustment type.

attributes : Array[AdjAttribute]

key : string

value : string

code : string

compPlan : number

The comp plan. Same value as in the criteria.compPlan field.

disqualified : boolean

forceAdjToHoldback : boolean

includeInInterpolationComp : boolean

key : string

Adjustment key.

llpa : number

margin : number

msr : number

pmiTypes : Array[string]

productCodes : Array[string]

qualifiedSpecialOptionFromAdj : Array[SpecialMortgageOption]

category : string

The category of the special mortgage option.

description : string

Description of the mortgage option.

dynamicProperties : object

enabled : boolean

Set to True if enabled.

id : ObjectId

The mortgage option ID, used for reference.

name : string

Name of the special mortgage option.

qualifiedSpecialOptionFromAdjFilter : Array[SpecialMortgageOption]

referenceId : string

The reference ID for the adjustment.

tags : Array[string]

targetType : string

triggerServicingGrouping : boolean

type : string

userGroupExternalId : string

valueType : string

ausIndicator : string

aus indicator

ausList : Array[string]

An adjustment filter, passed as a list of values representing adjustments. This field is required.

Enum values:

None
GUS
MUW
DU
LP

Example:

ausList: ["None", "LP", "DU"]

Note: Selecting MUW will cause disqualification because it is the disqualify adjustment for all conventional programs.

The solution is either to remove MUW or, if you want to see the disqualified products, set showDisqualify to True.

businessSourceType : string

The businessSourceType field is used for coding business sources to determine adjustments. The codes may represent a new customer, returning customer, veteran, and so on. The API provides up to 24 options, along with a N/A option, that the client can represent as they wish.

Values:

BST_NA("N/A", "N/A")

BST_1("1", "1")

BST_2("2", "2")

BST_3("3", "3")

BST_4("4", "4")

BST_5("5", "5")

BST_6("6", "6")

BST_7("7", "7")

BST_8("8", "8")

BST_9("9", "9")

BST_10("10", "10")

BST_11("11", "11")

BST_12("12", "12")

BST_13("13", "13")

BST_14("14", "14")

BST_15("15", "15")

BST_16("16", "16")

BST_17("17", "17")

BST_18("18", "18")

BST_19("19", "19")

BST_20("20", "20")

BST_21("21", "21")

BST_22("22", "22")

BST_23("23", "23")

BST_24("24", "24")

Example:

"businessSourceType": "BST_NA"
- Code is not applicable here. Returns all results.
"businessSourceType: "BST_1"
- Codes the search as whatever the client represents under BST_1 (e.g. returning customer).

closingCostRange : RangeClosingCost

Enter a range for the closing cost. This is use to return the result closest to par.

See RangeClosingCost for more details.

closestToPar : boolean

Set to "True" to return the rate closest to 0 (sometimes expressed as 100). This function considers the absolute value of the rate and returns either the positive or negative rate closest to 0. 

Returns one result per product.

Default is "False".

Examples:

If set to "True", results return something like the following:

Rate

-.500

Program Name

30/25 Yr Fixed Agency

.625

30 Year - 26 Year

closestToTargetValue : number

from : number

The low end of the rate range.

infinite : boolean

Default is False.

to : number

The high end of the rate range.

compPlan : number

Add a comp plan to a rate that doesn't have it. Default is null.

creationDate : string

internal only

dayLocks : integer

Lock Day Period. Default is 30, meaning 30 days. If daysLocks is not given in the request payload, pricing results of 30 days lock are returned.

Cannot pass multiple values for dayLocks as it is defined as an Integer.

Pricing results are returned based on this value only, and not the array list "dayLocksList":[ ].

Note: an input of multiple values such as "dayLocks": [30,45] triggers a 400 Bad Request error:

"error": "Bad Request", "message": "Could not read document: Cannot deserialize instance of int out of START_ARRAY token

dayLocksList : Array[integer]

internal only

Not used for integration.

displayConventionalRate : boolean

Setting it to True displays the conventional rate.

Default is False.

This field might be deprecated.

displayMultiple : integer

Default is False.

This field might be deprecated.

divisionSourceType : string

This field is client-specific.

executionType : string

feeServicer : FeeCompany

This field is client-specific. This refers to a third party fee service that determines fees for the client.

For more information, see Fee Company.

companyName : string

The name of the fee service company.

encompassTitleVendor : EncompassTitleVendor

Field containing the EncompassTitleVendor object.

abaNumber : string

accountNumber : string

address : string

address2 : string

affiliatedVendor : boolean

attorneyInfo : EncompassAttorneyInfo

branch : string

city : string

companyName : string

contactEmail : string

contactName : string

contactPhone : string

fax : string

isAffiliatedVendor : boolean

isPrimary : boolean

primary : boolean

rank : integer

state : string

vendorId : string

vendorName : string

zip : string

primary : boolean

Setting this field to True marks the fee company as the primary fee company.

Default is True.

vendorName : string

The name of the vendor.

vendorType : string

The vendor type.

feeServicerList : Array[FeeCompany]

This field is client-specific. Contains an array of third party fee services that determine fees for the client.

For more information, see Fee Company.

companyName : string

The name of the fee service company.

encompassTitleVendor : EncompassTitleVendor

Field containing the EncompassTitleVendor object.

primary : boolean

Setting this field to True marks the fee company as the primary fee company.

Default is True.

vendorName : string

The name of the vendor.

vendorType : string

The vendor type.

id : ObjectId

Object storing metadata for the BrokerCriteria model.

leadSourceType : string

The leadSourceType field is used for coding the source of the lead . This information can be used to make adjustments or for data collection.

This field is similar to businessSourceType.

Enum Values:

WEB("Web")
PHONE_INQUIRY("Phone Inquiry")
REFERRAL("Referral")
PORTFOLIO_RETENTION("Portfolio Retention")
TRADE_SHOW("Trade Show")
WORD_OF_MOUTH("Word of Mouth")
PURCHASED_LIST("Purchased List")
OTHER("Other")

Example:

"leadSourceType": "WEB"
- The source is from the internet.
"leadSourceType: "REFERRAL"
- The source is a referral.

lockExtensionCostRate : number

The cost to extend a lock on a loan, in percentage. Company specific.

Examples:

"lockExtensionCostRate": 1

lockGroup : string

The name of the lock group.

lockGroups : Array[string]

maxCompensation : number

The maximum broker compensation.

maxCompensationScript : string

minimunCompensation : number

Minimum value for broker compensation.

modifiedByOverride : string

internal value

overrideExistingComplan : boolean

Setting this value to True allows the user to override the compPlan value.

Default is False.

overrideMinMonthlyPaymentAmount : number

overrideMinMonthlyPaymentRate : number

pointsFinancedDollarAmount : number

priceBucketList : Array[DoubleRangeGeLe]

List of Point pricing buckets (Range of double)

from : number

The minimum value for the range.

to : number

The maximum value for the range.

pricingExceptionAmount : number

This field is used to set a discount to be applied after the final cost of the loan + closing cost. The value represents a dollar amount.

Examples:

"pricingException": 5000

Similar to exceptionRate.

pricingExceptionRate : number

This field is used to set a discount to be applied after the final cost of the loan + closing cost. The value represents a percent amount, and is a percentage of the loan.

Examples:

"pricingException": .10

Similar to exceptionAmount.

qmFilterLimit : integer

qm filter limit

Default is null

qmTreshold : Number

qm threshold

Default is null

qmTypes : Array[string]

rangeComplan : DoubleRangeGeLe

This field sets the range for the compensation (comp plan) that a loan officer receives.

Range values are stored in the fields to and from. Currently, the @class field must be populated.

Example:

"rangeComplan: {

"@class": "com.cre8techlabs.entity.range.DoubleRangeGeLe",

"from": 500,

"to": 2000

}

from : number

The minimum value for the range.

to : number

The maximum value for the range.

rateTypes : Array[string]

rateTypes will return only the specified rate types if set. If left null, the search will return all rate types. Passing "All" will also return all rate types.

The value passed depends on the "configuration" setup of your rate sheet.

Values:

"All"
"ForBroker"
"ForCorresponding"
"ForWholesale"
"AsRetail"

Example:

If pricing is marked as "ForBroker" under configuration, pass: "rateTypes":["ForBroker"]

See Rate Types for more information.

resultPerBucket : integer

Related to priceBucketList.

scriptWeight : integer

searchContext : object

The search context, set in an object.

Examples:

"searchContext": {}

sortStrategy : string

This field contains the sort strategy used for sorting results.

Default is "APR".

Values:

Value	Description
"APR"	Sorts by APR

Examples:
"sortStrategy": "APR"

subRateTypes : Array[string]

This field contains values for types of sub rates that can apply.

Values:

Examples:
"subRateTypes": ["", "", ""]

useExecutionType : boolean

view : string

internal only

byPassCap : boolean

closingCost : ClosingCost

allowErnstQuote : boolean

Appears in line result. This value is set to True if Ernst quote is allowed.

closingCostGroup : Array[ClosingCostGroup]

Contains an array of ClosingCostGroup objects with data for closing cost groups associated with the loan.

aprRelated : boolean

True if the closing cost is APR related.

closingCostItems : Array[ClosingCostItems]

An array of ClosingCostItems objects containing closing cost item data.

amount : number

amountScript : string

aprRelated : boolean

automaticallyCalculated : boolean

callForQuote : boolean

convertedFromPercenetage : boolean

ernstType : string

escrowWaiver : boolean

evalType : string

id : ObjectId

includeInQmCriteria : boolean

itemType : string

items : Array[ClosingCostItem]

amount : number

amountScript : string

aprRelated : boolean

automaticallyCalculated : boolean

callForQuote : boolean

convertedFromPercenetage : boolean

ernstType : string

escrowWaiver : boolean

evalType : string

id : ObjectId

includeInQmCriteria : boolean

itemType : string

label : string

name : string

notes : Array[string]

numberOfDaysForPrepaidInterest : integer

numberOfPayments : integer

percentPaidByBorrower : number

percentageOfLoanAmount : number

thirdPartyVendor : boolean

totalBorrower : number

totalBorrowerAprRelated : number

totalBroker : number

vendorName : string

label : string

name : string

notes : Array[string]

numberOfDaysForPrepaidInterest : integer

numberOfPayments : integer

percentPaidByBorrower : number

percentageOfLoanAmount : number

thirdPartyVendor : boolean

totalBorrower : number

totalBorrowerAprRelated : number

totalBroker : number

vendorName : string

customFeeGroup : Array[string]

A string array of custom fee groups.

customTables : Array[ClosingCostCustomTable]

An array of ClosingCostCustomTable objects storing custom closing cost tables.

ausTypes : Array[string]

columnItems : Array[ColumnCostItem]

applyTax : boolean

aprRelated : boolean

asPercentage : boolean

description : string

id : ObjectId

idx : integer

includeInQmCriteria : boolean

label : string

enable : boolean

id : ObjectId

includeInSearch : boolean

label : string

loanAmountRange : Array[DoubleRangeLeGt]

from : number

null : boolean

to : number

loanPurposes : Array[string]

loanTypes : Array[string]

loanYears : Array[integer]

mortgageTypes : Array[string]

name : string

propertyTypes : Array[string]

propertyUses : Array[string]

rawData : Array[HashMap]

states : Array[string]

tax : number

termsInMonths : boolean

values : Array[array]

variableLoanTypes : Array[string]

display : boolean

Set

fromErnstCost : boolean

True if the closing cost group is from Ernst cost.

groupType : string

Specifies the group type of the closing cost group.

id : ObjectId

The closing cost group ID, stored in the ObjectId object along with internal metadata.

name : string

The name of the closing cost group.

required : boolean

True if this closing cost group is required in the closing cost calculation.

total : number

Total value of the closing cost group.

directCustomFee : boolean

settlementCost : SettlementCost

Contains an array of SettlementCost objects with data on settlement costs associated with the loan.

closingCostGroup : Array[ClosingCostGroup]

closingCostGroup contains an array of ClosingCostGroup objects, each storing data on a closing cost group.

origination : Origination

Data on settlement cost origination, stored in the Origination object.

administration : number

administrationLabel : string

lenderCredit : number

lenderCreditLabel : string

others : number

othersLabel : string

total : number

underwriting : number

underwritingLabel : string

thirdPartyServices : ThirdPartyServices

Data on third party services, stored in the ThirdPartyServices object.

appraisal : number

appraisalLabel : string

creditReport : number

creditReportLabel : string

floodCertification : number

floodCertificationLabel : string

overnight : number

overnightLabel : string

recording : number

recordingLabel : string

taxService : number

taxServiceLabel : string

total : number

titleService : TitleService

Information on the title service of the settlement cost, stored in the TitleService object.

total : number

The settlement cost total amount.

total : number

Total closing cost value.

Example:

"total": 758

useClosingCost : boolean

True if calculated closing cost will be used.

useCompanyDefaultClosingCost : boolean

True if company default closing cost will be used.

useErnstCost : boolean

True if Ernst cost will be used.

combiKey : string

companyId : string

computedExpirationDate : string

creationDate : string

criteria : BorrowerCriteria

affinityCodes : Array[string]

An affinity code is an extra search criteria associated with products that can apply an additional adjustment . A common scenario use for is an employee code that will offer better pricing.

affinityCodes is a field that accepts an array of affinity codes and returns results for which any of the affinity codes are applicable.

Example:

"affinityCode": "ABC"

In this case, the 30 Year Conventional product has an adjustment when the affinity code is "ABC" that applies a -0.1 adjustment, or better pricing.

An HLA/Loan Officer who knows the code can enter it in the search UI or API and receive a -0.1 adjustment applied to the pricing.

affordableHousingType : Array[string]

affordableHousingTypes : Array[string]

alternateCreditScore : integer

ami : number

applicationTakenDate : string

appraisalConditionAsIs : boolean

appraisedValue : number

For conventional programs, this value needs to be higher than $0.

For purchase, the lower between appraisedValue and purchasePrice is used (LTV logic).

This field is required.

assumption : boolean

assumptionRate : number

averageMedianCreditScore : integer

balloon : boolean

borrowerCompPlanAmount : number

Specifies a numeric compensation plan (comp plan) value for the borrower.

borrowerCompPlanPercent : number

Specifies a compensation plan (comp plan) value for the borrower as a percentage.

buyDown : string

caseAssignementDate : string

cashoutAmount : number

cemaIndicator : boolean

CEMA indicator. CEMA loans are an option open to New Yorkers to reduce the cost to refinance a mortgage. True if the borrower qualifies for a CEMA loan.

Default is False.

citizenshipType : string

clientDti : number

closedEnd : boolean

closingDate : string

cltv : number

See cltv reference material.

communitySecond : boolean

compensationType : string

This field determines the type of compensation a borrower receives.

computeApr : boolean

If set to True, the APR will be calculated.

constructionDrawAmount : number

creditQualify : boolean

If the borrower's credit qualifies them for the loan, creditQualify is True.

docType : string

downPaymentAmount : number

Sets the down payment amount.

If not set, the value will be 0.

downRate : number

Sets the down rate amount.

If left empty, the value is 0.

drawAmount : number

drawAmount is the draw amount if the client would like to price HELOC or Second Lien.

dscr : number

dti : number

Debt-to-Income ratio. Set as a percentage.

Example:

"dti": 33

dutyToServe : boolean

employeeLoan : string

Contains the employee loan, if applicable.

escrowWaiver : boolean

This field corresponds to impound or not impound. Set to True if the client qualifies for an escrow waiver.

Default is False.

existingFirstLien : boolean

ext : boolean

fhaCaseNumber : string

If the borrower qualifies for an FHA loan, fhaCaseNumber is the ten digit number assigned to the loan, stored as a string value.

fhaEndorsementDate : string

fhaLoanTypes : Array[string]

fico : integer

firstLienPaymentAmount : number

firstTimeHomeBuyer : boolean

fundingFeeFinanced : string

This field is required only if pricing a VA loan. It does not have a default value. If no value is passed, no pricing is returned. This design is intentional.

guranteeFeeFinanced : string

This field is required only if pricing a USDA Rural loan and does not have a default value. If no value is passed, no pricing is returned. This design is intentional.

hcltvDrawAmount : number

The hcltv draw amount.

hcltvLineAmount : number

The hcltv line amount.

helocCriteria : HelocCriteria

applyLineAmount : boolean

highBalanceCounty : boolean

True if the property is in a high balance county.

inclusive : boolean

Set to True to include only the listed mortgage option.

Default is False.

incomeAmiRatio : number

interestOnly : boolean

isFirstLienSame : string

This field is simply a boolean that will activate a credit adjustment, which needs to be configured in the following fields:

Example:

This field is used if the client is doing a refinance and Lender Price was the original holder of the loan.

Default is null.

lenderFeeWaiver : boolean

Set to True to waive the admin fee.

Default value is False.

lienPriorityType : string

This field specifies the lien priority type.

Values:

"FirstLien"

Default value is “FirstLien” if no value is entered.

lineAmount : number

lmiData : LmiData

borLimit : number

chaseAA : boolean

commTract : string

id : ObjectId

lmiSubsidyId : string

lmiTract : integer

lmiType : string

msa : string

loanAmount : number

The loan amount. A dollar value.

Default if left blank is 0.

loanDownPayment : number

The down payment on the loan. A dollar value.

Default if left blank is 0.

loanPurpose : string

The purpose of the loan.

Values:

"Purchase"
"Refinance"
"StreamLineRefinance"
"CashoutRefinance"

Note:

This field is required only if doing a single search.

loanType : string

Specifies the type of loan.

Values:

"Fixed"
"Variable"

Default value is "Fixed".

Note:

This field is required only if doing a single search.

loanYear : integer

The loan term, in years.

Default value is 30.

This field is required only if doing a single search.

ltv : number

The ltv value.

monthlyDebt : number

This value is required to calculate Debt-to-Income, stored in the dti field.

monthlyIncome : number

This value is required to calculate Debt-to-Income, stored in the dti field.

monthlyReserve : number

The monthly reserve.

mortgageTypes : Array[string]

The types of mortgages to search for. Use this value is performing a multisearch.

Values:

"UsdaRural"
"VA"
"Conventional"
"BP"
"NonPrime"
"HELOC"
"NonAgency"

Default value: "mortgageTypes": ["Conventional"]

nonOccCoBorrower : boolean

nonWarrantableProject : boolean

normalHelocBehavior : boolean

numberOfBorrower : integer

numberOfCoBorrower : integer

occupancyRate : number

otherExpenses : number

ownProperties : integer

Number of borrower owned properties.

paymentInterestType : string

Sets the payment interest type.

Values:

"FullPITI"
"InterestOnly"
"InterestPlusFixedPrinciple"

payoffStatusIndicatorFirstLien : boolean

payoffStatusIndicatorSecondLien : boolean

percentageFeeCriteria : PercentageFeeCriteria

fundingFeeFinancedType : string

fundingFeeWaived : boolean

pmiType : string

Values:

"None"
"LPMI"
"BPMI"

priorSalesDate : string

propertyUse : string

Identifies the use for the property.

Values:

"PrimaryResidence"
"SecondaryVacation"
"Investment"

Default value is "PrimaryResidence".

propertyValuationType : string

Determines the type of property valuation.

Values:

"HVE"
"PIW"
"ACE"
"FMP"
"Full_Appraisal"
"Streamline"

purchasePrice : number

Specifies the purchase price of the property.

Default is 500000.

rehabBudget : number

Used to set the rehabilitation budget for the property.

Default is 0.

renovationCost : number

renovationLoan : boolean

rent : number

rentalPropertyCashFlowAmount : number

rural : boolean

selfEmployed : boolean

specialMortgageOptions : Array[SpecialMortgageOption]

Filters the result by the listed special mortgage options in the array of SpecialMortgageOption objects.

If there are no special mortgage options, set inclusive to False. Otherwise, set inclusive to True.

Examples:



  "specialMortgageOptions":[], 
"inclusive": false 

"specialMortgageOptions":[{"id":null,"name":"CDCore","description":"CDCore","enabled":true,"category":"AFR"}], 
"inclusive":true


"specialMortgageOptions":[{"id":null,"name":"SSLI","description":"SSLI","enabled":true,"category":"AFR"},{"id":null,"name":"CDCore","description":"CDCore","enabled":true,"category":"AFR"}], 
"inclusive":true

studentLoanIndicator : boolean

subordinateLoanAmount : number

Specifies the subordinate loan amount.

Default is 0.

subordinateSubType : string

ufmipFinanced : string

This field is mandatory only if pricing an FHA loan. There is no default value, meaning if no value is passed, no pricing is returned. This design is intentional.

useCustomerTotalLoanAmount : boolean

useSmoBackFilter : boolean

vaLoanTypes : Array[string]

vaUsageType : string

Values:

"First_Use"
"Subsequent_Use"

valueOfCollateral : number

Sets the value of the collateral.

Default is null.

varaiableLoanTypes : Array[string]

This field is required for Variable loan types. If the array is empty, Lender Price will search all possible types.

Values:

"_1_1"
"_2_1"
"_3_1"
"_5_1"
"_5_2"
"_5_5"
"_7_1"
"_7_2"
"_10_1"

Default is empty.

veteranType : string

Determines the veteran status of the borrower. Leaving null indicates the borrower is not a veteran.

Values:

"Active_Or_Veteran"
"Reserves_Or_National_Guard"

Default is null.

mortgageLimit : string

Lender Price calculates this value automatically.

Values:

"Conforming"
"HighBalance"
"Jumbo"

totalLoanAmountByMortgage : double

The total amount by mortgage.

date : string

dayLocksCriteria : Array[integer]

debugLevel : string

disqualifyAsync : boolean

disqualifyFullResult : boolean

dynamicPropertiesMap : object

encounteredUserGroups : object

externalCompensation : ExternalCompensation

compPlanDollarRange : CreditDollarRange

overrideComplan : number

overrideComplanFlatFee : number

feeCriteria : object

fhaloanTypeCriteria : Array[string]

fields : Array[string]

filter : SearchFilter

getRateGridFilterReason : boolean

ineligibleProduct : boolean

priceIneligibleProduct : boolean

productCode : Array[string]

This field is used to filter results for specific product codes. The product code(s) entered must be an exact match with those in the data.

This filter will return all programs that have any of the product codes associated with them.

Example:

"productCode": ["HomeReady"]

programNames : Array[string]

This field is used to filter results for specific program names. The program name(s) entered must be an exact match with those in the data.

This filter will return only the programs passed in the array.

Example:

"programName": ["Fannie Mae 30 Year Fixed"]

rateFilter : RateFilter

condition : string

filters : Array[RateFilterItem]

op : string

type : string

value : string

globalGroupAdjustmentMap : object

hideSettings : object

id : ObjectId

integrationRef : string

investorIds : Array[string]

investors : Array[string]

listAllRateProducts : boolean

loanAmountCriteria : Array[number]

loanPurposeCriteria : Array[string]

loanTypeCriteria : Array[string]

maxListingPerRate : integer

miCriteria : MiCriteria

amortizationType : string

The amortization type.

Enum values:

FullyAmmortized
OptionPayment
InterestOnly
PotentialNegativeAm

Example:

"amortizationType": "fullyAmortized",

borrowerNonTraditionalCredit : boolean

If the borrower has non-traditional credit, set to True.

Default is False.

borrowerSelfEmployed : boolean

If the borrower is self-employed, set to True.

Default is False.

buyDownPercent : string

If the borrower intends to buy-down, enter the rate. If the percent is zero, enter "None" or leave empty.

Values:

None_1_0_2_1_3_2_1

None
1
0
2
3

Example:

"buyDownPercent": "None"

buydownUpfrontAmount : number

If the borrower intends to buy-down with an upfront amount, enter the fee amount. If the amount is zero, enter 0 or leave empty.

Example:

"buydownUpfrontAmount": 0

coBorrowerFicoScore : integer

Enter the FICO score of the co-borrower, if there is one.

coBorrowerNonTraditionalCredit : boolean

If the co-borrower has non-traditional credit, set to True.

Default is False.

coBorrowerSelfEmployed : boolean

If the co-borrower is self-employed, set to True.

Default is False.

companyToken : string

duLpDecision : string

The duLp decision. Select one of the enum values.

Enum Values:

DU_Approve_Eligible
DU_Approve_Ineligible
DU_OutOfScope
DU_ReferWith_Caution
DU_ReferWith_Caution_IV
DU_Refer_Eligible
DU_Refer_Ineligible
LP_Accept_Eligible
LP_Accept_Ineligible
LP_Caution_AMinusEligible
LP_Caution_Eligible
LP_Caution_Ineligible

initialPremiumAtClosing : string

Enter the initial premium at closing, if there is one.

loanProgram : string

Enter the loan program, or leave null.

loanType : string

Select the loan type.

Enum Values:

Fixed
_1_1
_3_1
_3_3
_5_1
_7_1
_10_1
_15_1

Default is Fixed.

miAmortizationType : string

The amortization type. Same as the amortizationType field. Use the amortizationType field instead of this one.

Enum Values:

FullyAmmortized
OptionPayment
InterestOnly
PotentialNegativeAm

miCompanyId : string

Company ID

miCompanyName : string

Company name

miCoverage : number

miCoverages : Array[number]

miPremium : number

miPremiumFinancedIndicator : boolean

If the premium is financed, set to True.

Default is False.

miRateSource : string

The rate source

mode : string

monthlyPlanRefundable : boolean

If the monthly plan is refundable, set to True.

Default is False.

needCoBorrower : boolean

If the loan requires a co-borrower, set to True.

Default is False.

numberOfDeferredPayments : integer

The number of deferred payments allowed. Default is 0.

originationChannel : string

Origination channel of the loan. This field is optional.

Enum values:

Retail
WholesaleRetail

overrideDSCR : number

overrideDTI : number

paymentPlan : string

The name of the payment plan.

Enum values:

EZMonthly
SinglePremium
None

paymentType : string

The type of loan payment, e.g. monthly, annual, or single.

Enum values:

Monthly
Annually
Single

premiumRatePlanType : string

The premium rate plan type.

rateQuoteAllProductIndicator : boolean

Default is False.

rateQuoteProductComparisonIndicator : boolean

Default is False.

renewalType : string

The renewal type.

Enum values:

Constant
Amortizing
Single

singlePlanRefundable : boolean

Default is False.

useDefaultEstimatedMi : boolean

varaiableLoanType : string

The variable loan type, if applicable. Default is null.

Values: _1_1_2_1_3_1_5_1_5_2_5_5_7_1_7_2_10_1

modifiedByOverride : string

multiSearchClosingCostList : Array[MultiSearchClosingCost]

closingCost : ClosingCost

loanPurpose : string

loanType : string

searchInfo : Search

searchKey : string

state : string

name : string

onlyShowTargetPrice : boolean

onlyShowTargetRate : boolean

overrideCompPlanDate : string

priceQuoteRef : ObjectId

pricingOrigin : string

property : Property

address : Address

The address of a specific property.

censustract : string

Property ID in the national census data.

city : string

City where the property is located.

country : string

Country where the property is located.

county : string

County where the property is located.

This is used for countyFips. The best practice is to pass to alleviate issues when the same zip/state spans > 1 county (counties may have different loan limits).

Must pass state fips + county fips. Example, 25017 for Middlesex County, MA; 36103 for Suffolk, NY.

countyFips : string

CountyFips ID.

Populate this field if you are concerned that the state and zip area spans more than one county, in which case the API will only return the first county in the list.

countyName : string

Name of the county the property is located in.

defaultZipFipsComboOnMismatch : boolean

latitude : number

Property latitude.

longitude : number

Property longitude.

msa : string

province : string

The province where the property is located.

state : string

The state where the property is located.

Note: if only state and zip are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list. To avoid confusion, pass the countyFips.

stateFips : string

This field is DEFUNCT.

DO NOT USE.

street : string

The first line of the property street address.

Example: 10 Rose Court

streetCont : string

The second line of the property street address.

Example: Apt. C

zip : string

The property zip code.

Note: if only state and zip are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list. To avoid confusion, pass the countyFips.

zipExt : string

The four digit zip code area extension. The dash is not necessary.

Example: 2435

Do not enter in this format: -2435

attachmentType : string

A descriptor of a property's attachment type. Takes one of the values listed below.

Enum Values:

Attached
Detached
SemiDetached

bathrooms : number

The number of bathrooms in the property.

Value is stored as a double to account for half bathrooms.

Examples:

1
1.5
2

bedrooms : integer

The number of bedrooms in the property.

constructions : Array[string]

Accepts a string array.

creationDate : string

The date _ was created.

facts : Array[string]

Accepts a string array.

features : Array[string]

An array of features that the property contains. For example, to search for waterfront property with a wraparound porch, enter an array containing keywords of the features.

Example:

["waterfront", "wraparound porch"]

finishedSqFt : number

The area of the property, in square feet.

forSale : boolean

Indicates whether the property is for sale. Default is for sale, or True.

hoa : number

Accepts a double value.

id : ObjectId

ID of the Property object, stored as an ObjectID.

images : object

The property images, stored in a JSON object.

jsonImages : Array[JsPropertyFieldFile]

An array of JsPropertyFieldFile objects containing image data.

fileType : string

The file type, or file extension.

Example:

JPG
PNG
PDF
TIFF

filename : string

The name of the file.

key : string

objectId : string

The database ID for the image file, used to retrieve it from the database.

lastSoldDate : string

The last date on which this property was sold.

This field works in tandem with forSale, and should be populated if forSale is False.

Example: January 1, 2000

lastSoldPrice : number

The price at which the property was last sold.

links : Array[string]

Relevant links returned with each property.

lotSizeAcre : number

Property lot size in acres.

lotSizeSqFt : number

Property lot size in square feet.

mls : string

Accepts a string value.

modifiedByOverride : string

String that returns the date it was modified and who it was modified by.

numberOfUnit : integer

The number of units in the property. Default value is 1.

price : number

The price of the unit.

priceDate : string

The date on which the current price was set.

propertyDescription : string

A description of the property.

propertyTaxPercent : number

The property tax for the property, given as a percent out of 100.

Example: 3

propertyTaxYear : string

The year on which the current property tax was set. Returns a null string if there is has not been a property tax on this property.

propertyType : string

The type of property. Takes one of the values listed below. Default value is "SingleFamily".

Enum Values:

SingleFamily
Apartment
Condominium
Townhome
Townhouse
DetachedCondominium
HighRiseCondo
SiteCondo
ManufacturedHousingDoubleWide
ManufacturedHousingSingleWide
Cooperative
MultiFamily
ManufacturedHousing
ManufacturedHomeCondominium
ManufacturedHousingMultiWide
UnitDwelling_2_4

taxAssessment : number

The tax assessment for the property. Returns 0 if there has not been a tax assessment.

taxAssessmentYear : string

The year the property tax assessment was completed. Returns null string if tax assessment was never completed.

totalRooms : integer

The total number of rooms in the property.

yearBuilt : integer

The year the property was built.

rate : number

rateGridIds : Array[ObjectId]

ratePeriodIdOverride : ObjectId

ratePeriodIds : Array[ObjectId]

rateProgramIds : Array[ObjectId]

rateRange : DoubleRangeLeGt

from : number

null : boolean

to : number

rates : Array[number]

requestId : string

showAdjustmentDetail : boolean

showAllDayLocksForInterpolatedRates : boolean

showDisqualify : boolean

showDisqualifyRules : boolean

showInterpolatedPricing : boolean

showPayeeDetail : boolean

showTitleQuestion : boolean

showUnmatchCompPlan : boolean

skipAdjustments : boolean

sortAscPoints : boolean

targetInterpolatedPrices : Array[number]

targetUndiscountedPrice : number

termsCriteria : Array[integer]

termsInMonths : boolean

test : boolean

titleVendorQuestions : Array[CustomTitleQuestionWrapper]

titleVendors : Array[TitleVendor]

abaNumber : string

accountNumber : string

address : Address

affiliatedVendor : boolean

attorneyInfo : ContactPerson

branch : string

companyName : string

contact : ContactDetails

contactName : string

primary : boolean

vendorId : string

vendorName : string

useApplicationDateAsPricingDate : boolean

useCurrentBasePricing : boolean

useExternalCompensation : boolean

useExternalFees : boolean

varLoanTypeCriteria : Array[string]

searchPoint : SearchPoint

The search point that contains data regarding the priced product

valid : boolean

Name	Description	Data Type
creationDate		string
id		ObjectId
modifiedByOverride		string
origin	The source of where the pricing result came from. These sources are fixed set enums	string
pricedOnMarketPlace	A boolean flag used to indidcate if the pricing result came from the market place view.	boolean
pricingUserFullName		string
pricingUserId		ObjectId
search	The search used to generate the priced product that will be used to update the lock.	Search
searchPoint	The search point that contains data regarding the priced product	SearchPoint
valid		boolean

Lender Price API Web Service